Fix docstrings #27621
Fix docstrings #27621
Conversation
|
odd that the doc string checks don’t catch this |
There was a problem hiding this comment.
Thanks @albertvillanova for this, nice fixes.
It feels like sphinx should be raising warnings for those, but I guess both sphinx and our script consider those as just part of a paragraph.
Can you leave the CI green (I guess the failure is unrelated to this PR, and you can simply merge master or add an empty commit).
And also, if you can open an issue to validate those automatically, and may be work on adding validation for this in the scripts/validate_docstrings.py script, that would be great.
2 dots followed by text (and no 2 colons) are valid reST comments, thus ignored by the parser: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#comments |
|
Thanks @albertvillanova, that's good to know. I think then we should make sure in If you don't mind creating an issue for that, and referencing this PR in it, so we can see where it came from, that would be great. And thanks for the PR! |
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffThis fixes some docstring formatting issues: e.g. some deprecated directives do not appear in current docs because the two colons are missing
.. deprecated 0.25.0.